Skip to content

Docs audit remediation - #821

Merged
khushalsonawat merged 4 commits into
devfrom
docs/audit-remediation
Aug 18, 2026
Merged

Docs audit remediation#821
khushalsonawat merged 4 commits into
devfrom
docs/audit-remediation

Conversation

@khushalsonawat

@khushalsonawat khushalsonawat commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

What

Remediates the findings from the six 17 Aug docs audits and ships the new usage-based Billing section.

  • Fixes ~50 register items: broken code samples across quickstarts, cookbooks and integrations (wrong packages, missing imports, dead syntax), the llms-full.txt extractor (imports, fenced code, placeholders and param rows were being stripped from the AI export), the eval count corrected to 132 templates across 8 groups, Protect metric vocabulary aligned with the backend, self-contradictions on the roles, self-hosting and gateway pages, and 59 typos
  • Consolidates the duplicated 41-page tracing tree: tracing/auto merged into integrations/traceai (keeping the newer fixes from both sides), ~120 links repointed, 42 permanent redirects added, the missing traceai index created
  • Surfaces the previously hidden Resources nav group as RBAC, deletes the legacy installation and billing-pricing pages with redirects, folds Protect into Build & connect
  • Adds /docs/billing: five pages under RBAC plus an interactive pricing calculator, with tier ladders and platform fees read from ee/cloud/billing source and its test suite

Why

Six independent audits (agent-readiness, docs quality, Nosang, Salil, full crawl, coding agent) landed the same day with 115 deduplicated findings, including P0s that break copy-pasted code and the AI-facing exports. The legacy billing page documented the retired top-up system, so billing had to be rewritten from the current source rather than patched.

What cases were covered

  • Every audit claim was re-verified against the repo or backend source before fixing; 16 claims were struck as wrong with reasons recorded
  • Tracing consolidation ordered so nothing 404s mid-migration: port fixes, create index, add redirects, repoint links, then delete
  • Billing numbers cross-checked against the test suite that asserts the tiers; calculator self-check values verified (80 GB storage = $60.00, 600 GB = $1,050.00)
  • All five billing pages passed accuracy review against the source extract, house-style review, and a cold read; nav paths match the live dashboard labels

How

Notes-first fix pipeline against the recorded audit findings (one fixer + one confirming reviewer per item), a research-plan-write-review workflow for the billing section grounded in ee/cloud/billing, and deterministic scripted merges for the tracing tree. Screenshots captured over the CDP rig at the 3024x1890 standard, masked per convention.

Recording

No video for this change. The two new captures are on the billing guides: /docs/billing/guides/control-spend (usage overview) and /docs/billing/guides/manage-your-plan (plans page).

🤖 Generated with Claude Code

- llms-full.txt extractor: preserve fenced code, imports, placeholders,
  param rows and method lines in the AI export
- exclude chat widget and copy dropdown chrome from Pagefind indexing
- fix broken code samples across quickstarts, cookbooks and integrations
  (fi-instrumentation-otel package, JS projectType casing, missing imports)
- correct the built-in eval count to 132 templates across 8 groups (21 files)
- surface the hidden Resources nav group as RBAC under Administration
- delete legacy installation and billing-pricing pages with redirects

Signed-off-by: khushalsonawat <khushalsonawat@gmail.com>
- consolidate the duplicate tracing tree: merge auto-side fixes into
  integrations/traceai, port the missing index, repoint 120 links,
  add 42 permanent redirects, delete tracing/auto
- add redirects for guessable 404 paths and the orphaned quickstart URL
- point the header MCP link straight at its target
- align Protect metric vocabulary with the backend on guides and SDK pages
- resolve self-contradictions: roles page (verified against backend RBAC),
  self-hosting build-vs-pull, gateway endpoint and guardrail counts
- local code/statistical eval pages no longer pass an evaluator model;
  audio evals use turing_large
- normalize Python floor to 3.10+, evaluator model casing, package
  install spellings; retitle 12 landing pages off the bare word Overview
- state Cloud/Enterprise availability on Falcon AI and Protect
- add verified agentcc install step to Command Center quickstart
- remove stale prism-ai banners, self-referential links, 59 typos

Signed-off-by: khushalsonawat <khushalsonawat@gmail.com>
@khushalsonawat khushalsonawat self-assigned this Aug 17, 2026
@entelligence-ai-pr-reviews

Copy link
Copy Markdown

Automatic Review Skipped

Too many files for automatic review.

If you would still like a review, you can trigger one manually by commenting:

@entelligence review

- five pages under RBAC: overview, what you are billed for, plans &
  pricing reference, manage your plan, control spend
- interactive PricingCalculator component with the graduated tier
  ladders and platform fees read from source
- nav paths matched to the real dashboard labels (Usage Summary,
  Plans & Pricing, Billing) with two masked captures
- billing references in FAQ, Falcon AI and Prompt troubleshooting
  repointed at the new section
- Protect group folded into Build & connect in the sidebar dropdown

Signed-off-by: khushalsonawat <khushalsonawat@gmail.com>
- both shots retaken over the CDP capture rig, uncropped, masked
- italic captions added below both embeds

Signed-off-by: khushalsonawat <khushalsonawat@gmail.com>
@khushalsonawat
khushalsonawat merged commit b6983bd into dev Aug 18, 2026
1 check passed
@khushalsonawat
khushalsonawat deleted the docs/audit-remediation branch August 18, 2026 04:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants